audio refactor: replace deprecated PLAY_NOTE_ARRAY #8484

JohSchneider · 2020-03-19T01:49:48Z

remove the deprecated PLAY_NOTE_ARRAY macro throughout the code, and replace it with PLAY_SONG

Description

Types of Changes

Issues Fixed or Closed by This PR

code cleanup :-)
*

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

zvecr

https://docs.qmk.fm/#/breaking_changes_instructions

As this modifies user keymaps, we either need to get sign off from them, or go via breaking changes process.

JohSchneider · 2020-03-19T02:23:26Z

the replaced macro internally redirected to PLAY_SONG anyway - the keymaps that still used the PLAY_NOTE_ARRAY won't notice the difference => not breaking anything :-)

zvecr · 2020-03-19T02:25:50Z

You might have a different view for what the terminology would mean, however it falls under the following in the linked docs:

Edits to User Keymaps A user may submit their keymap to QMK, then some time later open a pull request with further updates, only to find it can’t be merged because it was edited in the qmk/qmk_firmware repository. As not all users are proficient at using Git or GitHub, the user may find themself unable to fix the issue on their own.

JohSchneider · 2020-03-19T02:45:15Z

ok - thats a good point

JohSchneider · 2020-04-24T12:41:09Z

is it correct to have this branch set to 'merge into furture' for it to be considered in the next merge window, or should it stay on master?

noroadsleft · 2020-04-25T23:20:21Z

If you want this to go in through the next Breaking Changes cycle, it needs to target the future branch, and be ready to ship by next Saturday (unless we change the timeline).

There are some details in the docs to which your PR will need to conform to be considered for the next Breaking Changes cycle. Of particular note, you will need to add a changelog entry to this PR to have it merged in.

JohSchneider · 2020-04-26T04:51:30Z

ok, thanks for the confirmation
a chagnelog is presetn, the PR is - at least from my side - ready... all thats missing are reiviews :-)

noroadsleft · 2020-05-05T16:31:08Z

@JohSchneider Would you mind rebasing this on future one last time?

…_SONG

…n documentation

JohSchneider · 2020-05-06T14:17:38Z

git rebase origin/future; git push --force; echo "done :-)"

noroadsleft · 2020-05-06T17:14:43Z

Thanks!

* audio refactoring: replace deprecated macro PLAY_NOTE_ARRAY with PLAY_SONG * audio refactoring: drop deprecated (and unused) PLAY_NOTE_ARRAY macro * audio refactoring: replace deprecated PLAY_NOTE_ARRAY wit PLAY_SONG in documentation * audio refactor: add Changelog entry for 'future'

* Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) * Convert V-USB usbdrv to a submodule (#8321) * Unify Tap Hold functions and documentation (#8348) * Changing board names to prevent confusion (#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (#8499) * Move spaceman keyboards (#8830) * Migrate miscellaneous `fn_actions` entries (#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (#8537) * Refactor Lily58 to use split_common (#6260) * Refactor zinc to use split_common (#7114) * Add a message if bin/qmk doesn't work (#9000) * Fix conflicting types for 'tfp_printf' (#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480) * Refactor and updates to TKC1800 code (#8472) * Switch to qmk forks for everything (#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484) * Audio enable corrections (2/3) (#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582) * Audio enable corrections (Part 4) (#8974) * Fix typo from PR7114 (#9171) * Augment future branch Changelogs (#8978) * Revert "Branch point for 2020 May 30 Breaking Change"

* Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (qmk#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (qmk#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (qmk#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (qmk#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (qmk#8968) * Convert V-USB usbdrv to a submodule (qmk#8321) * Unify Tap Hold functions and documentation (qmk#8348) * Changing board names to prevent confusion (qmk#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (qmk#8499) * Move spaceman keyboards (qmk#8830) * Migrate miscellaneous `fn_actions` entries (qmk#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (qmk#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (qmk#8537) * Refactor Lily58 to use split_common (qmk#6260) * Refactor zinc to use split_common (qmk#7114) * Add a message if bin/qmk doesn't work (qmk#9000) * Fix conflicting types for 'tfp_printf' (qmk#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (qmk#6480) * Refactor and updates to TKC1800 code (qmk#8472) * Switch to qmk forks for everything (qmk#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (qmk#8484) * Audio enable corrections (2/3) (qmk#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (qmk#8582) * Audio enable corrections (Part 4) (qmk#8974) * Fix typo from PR7114 (qmk#9171) * Augment future branch Changelogs (qmk#8978) * Revert "Branch point for 2020 May 30 Breaking Change"

JohSchneider force-pushed the audio-refactor_play-array branch 2 times, most recently from a7a9c5f to 3abe429 Compare March 19, 2020 01:55

zvecr requested changes Mar 19, 2020

View reviewed changes

zvecr added breaking_change Changes that need to wait for a version increment core keymap keyboard labels Mar 19, 2020

zvecr requested a review from a team March 19, 2020 02:20

JohSchneider requested review from zvecr and removed request for a team April 11, 2020 12:01

JohSchneider force-pushed the audio-refactor_play-array branch from b3c9762 to de4c30f Compare April 24, 2020 12:34

JohSchneider changed the base branch from master to future April 24, 2020 12:39

noroadsleft force-pushed the future branch from e42e791 to 4445fc5 Compare April 24, 2020 18:54

drashna approved these changes Apr 28, 2020

View reviewed changes

drashna requested a review from a team April 28, 2020 07:53

noroadsleft force-pushed the future branch from 4445fc5 to 43fa4c2 Compare April 29, 2020 17:02

noroadsleft added the awaiting review label May 4, 2020

zvecr approved these changes May 4, 2020

View reviewed changes

Johannes added 4 commits May 6, 2020 16:14

audio refactoring: replace deprecated macro PLAY_NOTE_ARRAY with PLAY…

f8f7f59

…_SONG

audio refactoring: drop deprecated (and unused) PLAY_NOTE_ARRAY macro

2f8fa2b

audio refactoring: replace deprecated PLAY_NOTE_ARRAY wit PLAY_SONG i…

904cc99

…n documentation

audio refactor: add Changelog entry for 'future'

c28f2b1

JohSchneider force-pushed the audio-refactor_play-array branch from de4c30f to c28f2b1 Compare May 6, 2020 14:15

noroadsleft approved these changes May 6, 2020

View reviewed changes

noroadsleft added future_2020q2 and removed awaiting review labels May 6, 2020

noroadsleft merged commit 30dd34e into qmk:future May 6, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

audio refactor: replace deprecated PLAY_NOTE_ARRAY #8484

audio refactor: replace deprecated PLAY_NOTE_ARRAY #8484

JohSchneider commented Mar 19, 2020

zvecr left a comment

JohSchneider commented Mar 19, 2020

zvecr commented Mar 19, 2020

JohSchneider commented Mar 19, 2020

JohSchneider commented Apr 24, 2020

noroadsleft commented Apr 25, 2020

JohSchneider commented Apr 26, 2020

noroadsleft commented May 5, 2020

JohSchneider commented May 6, 2020

noroadsleft commented May 6, 2020

audio refactor: replace deprecated PLAY_NOTE_ARRAY #8484

audio refactor: replace deprecated PLAY_NOTE_ARRAY #8484

Conversation

JohSchneider commented Mar 19, 2020

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

zvecr left a comment

Choose a reason for hiding this comment

JohSchneider commented Mar 19, 2020

zvecr commented Mar 19, 2020

JohSchneider commented Mar 19, 2020

JohSchneider commented Apr 24, 2020

noroadsleft commented Apr 25, 2020

JohSchneider commented Apr 26, 2020

noroadsleft commented May 5, 2020

JohSchneider commented May 6, 2020

noroadsleft commented May 6, 2020